Api.WriteSlaveAlias method

Writes an alias address into an EtherCAT slave.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsCommandStatus WriteSlaveAlias(
       int SlaveId,
       ushort Alias
)

Public Function WriteSlaveAlias(
       SlaveId As Integer,
       Alias As UShort
) As KsCommandStatus

Parameters

SlaveId

Type: int

The slave index. This index value is automatically assigned by the KINGSTAR master when the EtherCAT network starts, based on the physical connection order. The first device connected directly to the master is assigned Index 0, followed by Index 1, Index 2, and so on. These indexes remain consistent within the slave array even if devices are added, removed, or reconnected. Please refer to the use cases in HotConnect, Repair, and Restart for more details.

Alias

Type: ushort

The alias address to use. See the AliasAddress in the SlaveStatus class.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Remarks

Some EtherCAT slaves don't accept alias address being modified. If the master writes a value that is not acceptable to the slave, the slave may display an error and refuse to start.

Usable EtherCAT states

ecatInit, ecatPreOP, ecatSafeOP, ecatOP

Examples

N/A